doc: Updates to nrf_modem. socket header files, and socket documentation #1904
Conversation
github-actions
bot
added
the
doc-required
divipillai
changed the title
divipillai
changed the title
divipillai
force-pushed
the
NCSDK-35090_nrfsocket_header
branch
2 times, most recently
from
5f12e63 to
dd78e8c
Compare
divipillai
requested review from
SeppoTakalo,
eivindj-nordic,
kacperradoszewski and
nordic-hani
kacperradoszewski
left a comment
kacperradoszewski
left a comment
There was a problem hiding this comment.
Since NRF_SO_SENDCB is mentioned here already, maybe we should wait until #1897 is merged
divipillai
force-pushed
the
NCSDK-35090_nrfsocket_header
branch
from
dd78e8c to
758b8f9
Compare
| This flag is only supported for the :c:func:`nrf_send` and :c:func:`nrf_sendto` functions. | ||
| When this flag is used, the operation is blocked until the data has been acknowledged by the peer, if required by the network protocol, or until the timeout, given by the :c:macro:`NRF_SO_SNDTIMEO` socket option, is reached. | ||
| The valid timeout values are 1 to 600 seconds. | ||
| For TCP, the operation is blocked until the data is acknowledged by the peer, and for UDP, until the data is sent on-air by the modem. |
There was a problem hiding this comment.
I think it's better to refer to stream and datagram sockets instead of TCP and UDP, which are protocols.
There are more protocols for which this flag applies, but the socket types (stream, datagram) actually cover the behavior in all cases.
There was a problem hiding this comment.
Updated as below. Please check:
For the :c:macro:
NRF_SOCK_STREAMsocket type , the operation is blocked until the data is acknowledged by the peer, and for the :c:macro:NRF_SOCK_DGRAMsocket type, until the data is sent on-air by the modem.
| When this flag is used, the operation is blocked until the data has been acknowledged by the peer, if required by the network protocol, or until the timeout, given by the :c:macro:`NRF_SO_SNDTIMEO` socket option, is reached. | ||
| The valid timeout values are 1 to 600 seconds. | ||
| For TCP, the operation is blocked until the data is acknowledged by the peer, and for UDP, until the data is sent on-air by the modem. | ||
| This flag is useful in scenarios where data integrity and confirmation of receipt are critical. |
There was a problem hiding this comment.
This flag has no effect on data integrity, only when the user needs confirmation that the data has been sent and, if supported by the protocol, confirmation that it has been received.
There was a problem hiding this comment.
Updated as below:
This flag is useful in scenarios where confirmation of receipt is critical.
| * :c:macro:`NRF_MSG_WAITACK` | ||
| Requests a blocking send operation until the request is acknowledged. | ||
| This flag is only supported for the :c:func:`nrf_send` and :c:func:`nrf_sendto` functions. | ||
| When this flag is used, the operation is blocked until the data has been acknowledged by the peer, if required by the network protocol, or until the timeout, given by the :c:macro:`NRF_SO_SNDTIMEO` socket option, is reached. |
There was a problem hiding this comment.
This is not very accurate. It could also be merged with the part below. What about:
When this flag is used, write operations on datagram sockets block until the data has been sent on air, and write operations on stream sockets block until data reception is acknowledged by the peer. The operation timeout can be configured using the ... socket option.
There was a problem hiding this comment.
Updated as below:
When this flag is used, write operations on datagram sockets are blocked until the data has been sent on air, and write operations on stream sockets are blocked until data reception is acknowledged by the peer.
The operation timeout can be configured using the :c:macro:NRF_SO_SNDTIMEOsocket option.
cc: @kacperradoszewski .
Updates to nrf_modem and socket header files to improve modem library "limits" documentation Signed-off-by: divya pillai <[email protected]>
divipillai
force-pushed
the
NCSDK-35090_nrfsocket_header
branch
from
758b8f9 to
3427028
Compare
Add section for Supported flags for socket functions Signed-off-by: divya pillai <[email protected]>
divipillai
force-pushed
the
NCSDK-35090_nrfsocket_header
branch
from
3427028 to
752f111
Compare
|
4 participants
Updates to nrf_modem and socket header files
to improve modem library "limits" documentation.
Added Supported flags for socket functions section.
NCSDK-35090 and NCSDK-34607